'\" te
.\" Copyright (c) 2009, Sun Microsystems Inc. All Rights Reserved.
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
.\"  See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with
.\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
.TH STMFGETPERSISTMETHOD 3STMF "May 8, 2009"
.SH NAME
stmfGetPersistMethod \- get the current persistence method for stmf
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag\fR... ] \fIfile\fR... -lstmf [ \fIlibrary\fR... ]
#include <libstmf.h>

\fBint\fR \fBstmfGetPersistMethod\fR(\fBuint8_t *\fR\fIpersistType\fR, \fBboolean_t\fR \fIserviceState\fR);
.fi

.SH PARAMETERS
.sp
.ne 2
.na
\fB\fIpersistType\fR\fR
.ad
.RS 16n
On success, contains the current persistence setting based on
\fIserviceState\fR.
.RE

.sp
.ne 2
.na
\fB\fIserviceState\fR\fR
.ad
.RS 16n
When set to \fBB_TRUE\fR, \fIpersistType\fR will contain the persist method
currently set for the service. When set to \fBB_FALSE\fR, \fIpersistType\fR
will contain the persist method for the current library open.
.RE

.SH DESCRIPTION
.sp
.LP
The \fBstmfGetPersistMethod()\fR function retrieves the current persistent
method setting for the service or for a given library open. When set to
\fBB_TRUE\fR, retrieves the setting from the service.
.SH RETURN VALUES
.sp
.LP
The following values are returned:
.sp
.ne 2
.na
\fB\fBSTMF_STATUS_SUCCESS\fR\fR
.ad
.RS 27n
The API call was successful.
.RE

.sp
.ne 2
.na
\fB\fBSTMF_ERROR_PERSIST_TYPE\fR\fR
.ad
.RS 27n
Unable to retrieve persist type from service.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(7) for descriptions of the following attributes:
.sp

.sp
.TS
box;
c | c
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE
_
Interface Stability	Committed
_
MT-Level	Safe
.TE

.SH SEE ALSO
.sp
.LP
.BR libstmf (3LIB),
.BR attributes (7)
